--- title: "Listar Coleções de uma loja" method: GET path: "/{alias}/public/catalog/collections{?id[]={collectionId}}" tags: ["Público - Catálogo"] --- # Listar Coleções de uma loja `GET /{alias}/public/catalog/collections{?id[]={collectionId}}` ## Request - Base URL: `https://api.dooki.com.br/v2` - URL: `https://api.dooki.com.br/v2/{alias}/public/catalog/collections{?id[]={collectionId}}` - Auth: none required Retorna as Informações públicas das coleções ## Path parameters - `alias` string, required ## Query parameters - `id[]` string, required ## Response `200` Retorna as Informações públicas de uma Coleção - CollectionPublic: Recursos adicionais da coleção, retornados sob demanda via parâmetro `include`. - `id` integer: ID da coleção. - `parent_id` integer: ID da coleção pai, quando a coleção for uma subcoleção. - `active` boolean: Indica se a coleção está ativa e visível na loja. - `show_banners` boolean: Indica se os banners vinculados à coleção são exibidos na página dela. - `featured` boolean: Indica se a coleção é destacada na navegação da loja. - `is_promotional` boolean: Indica se a coleção é promocional, com período de vigência definido por `start_at` e `end_at`. - `name` string: Nome da coleção. - `visible_products` integer: Quantidade de produtos exibidos na vitrine da coleção. - `home` boolean: Indica se a coleção é exibida na página inicial da loja. - `expired` boolean: Indica se a data de término da coleção já passou. - `slug` string: Slug da coleção, usado na composição da URL. - `description` string: Texto descritivo exibido na página da coleção. - `seo_title` string: Título usado para SEO (tag `title`) da página da coleção. - `seo_keywords` string: Palavras-chave usadas para SEO da página da coleção. - `seo_description` string: Descrição usada para SEO (meta description) da página da coleção. - `path` string: Caminho relativo para o recurso. - `expire_in` string: Tempo restante até a expiração, descrito em formato textual (ex.: 'dentro de 998 anos'). - `total_products` integer: Número total de produtos relacionados ao recurso. - `restriced` boolean: Indica se a coleção tem regras de restrição de produtos (inclusão ou exclusão por marca e categoria). - `url` string, uri: URL completa da página da coleção na loja. - `stopwatch` string: Tipo da contagem regressiva exibida na coleção: `daily` (reinicia todo dia) ou `expiration_date` (conta até a data de término). - `stopwatch_expires_in` string: Data e hora em que a contagem regressiva termina: o fim do dia atual quando `stopwatch` for `daily`, ou a data de término da coleção. - `start_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer: Número de representação do timezone. - `timezone` string: Fuso horário associado. - `end_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer: Número de representação do timezone. - `timezone` string: Fuso horário associado. - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer: Número de representação do timezone. - `timezone` string: Fuso horário associado. - `updated_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer: Número de representação do timezone. - `timezone` string: Fuso horário associado. - `products` ProductPublic[]: Produtos vinculados à coleção. - `data` object: Dados do produto. - `id` integer: ID do produto. - `sku_id` integer: ID do SKU representativo do produto no resultado. - `gift_value` number, float: Valor cobrado pela embalagem de presente do produto, quando aplicável. - `simple` boolean: Indica se o produto é simples, sem variações. - `has_variations` boolean: Indica se o produto possui variações (ex.: cor, tamanho). - `is_digital` boolean: Indica se o produto é digital (sem envio físico). - `warranty` integer: Prazo de garantia do produto, em meses. - `custom_shipping` boolean: Indica se o produto usa frete customizado, em vez do frete padrão da loja. - `shipping_price` number, float: Valor de frete fixo configurado para o produto, quando `custom_shipping` for verdadeiro. - `name` string: Nome do produto. - `slug` string: Slug do produto, usado na URL da página do produto. - `sku` string: Lista de SKUs separados por vírgula. - `blocked_sale` boolean: Indica se o produto está bloqueado para novos pedidos. - `rating` string: Nota média de avaliação do produto, formatada para exibição. - `total_approved_reviews` integer: Quantidade de avaliações aprovadas do produto. - `url` string, uri: URL completa da página do produto na loja. - `url_path` string: Caminho relativo da URL da página do produto. - `use_different_images` integer: Indica se o produto usa imagens diferentes para cada variação (ex.: uma imagem por cor). - `brand` object: Marca do produto. - `data` object: Dados da marca do produto. - `id` integer: ID da marca do produto. - `name` string: Nome da marca do produto. - `logo_url` string, nullable: URL do logotipo da marca. - `images` object: Imagens do produto. - `data` object[]: Lista das imagens do produto. - `url` string, uri: URL da imagem do produto. - `prices` object: Preços e condições de pagamento do produto. - `data` object: Dados de preços e condições de pagamento do produto. - `currency` string: Moeda utilizada para exibição dos valores de preço, sempre representada como 'R$'. - `price_cost` number, float: Preço de custo do produto, usado internamente para cálculo de margem. - `price_cost_formated` string: Preço de custo formatado para exibição. - `price` number, float: Preço final do produto, já com o preço promocional e as promoções ativas aplicados. - `price_formated` string: Preço final formatado para exibição. - `base_amount` string: Parte inteira, em reais, do valor total (ex.: '100' em R$ 100,50). - `fraction_amount` string: Parte decimal, em centavos, do valor total (ex.: '50' em R$ 100,50). - `price_sale` number, float: Preço de tabela do produto, sem descontos aplicados. - `price_sale_formated` string: Preço de tabela formatado para exibição. - `price_discount` number, float: Preço promocional cadastrado no produto. Quando maior que zero, substitui o preço de tabela. - `price_discount_formated` string: Preço promocional formatado para exibição. - `has_promotion` boolean: Indica se o preço final ficou abaixo do preço de tabela. - `percent_discount` number, float: Percentual de desconto entre o preço de tabela e o preço final. - `billet` object: Condições de pagamento via boleto. - `price` number, float: Preço do produto quando pago via boleto. - `price_formated` string: Preço via boleto formatado para exibição. - `base_amount` string: Parte inteira, em reais, do valor total via boleto (ex.: '100' em R$ 100,50). - `fraction_amount` string: Parte decimal, em centavos, do valor total via boleto (ex.: '50' em R$ 100,50). - `discount_value` number, float: Valor do desconto aplicado ao preço via boleto. - `discount_percent` string: Percentual de desconto aplicado ao preço via boleto. - `discount_text` string: Texto pronto de exibição do desconto do boleto (ex.: '10% off no boleto'). - `pix` object: Condições de pagamento via Pix. - `price` number, float: Preço do produto quando pago via Pix. - `price_formatted` string: Preço via Pix formatado para exibição. - `base_amount` string: Parte inteira, em reais, do valor total via Pix (ex.: '100' em R$ 100,50). - `fraction_amount` string: Parte decimal, em centavos, do valor total via Pix (ex.: '50' em R$ 100,50). - `discount_value` number, float: Valor do desconto aplicado ao preço via Pix. - `discount_percent` string: Percentual de desconto aplicado ao preço via Pix. - `discount_text` string: Texto pronto de exibição do desconto do Pix (ex.: '10% off no Pix'). - `installments` object: Condições de parcelamento do produto. - `data` object: Dados das condições de parcelamento do produto. - … - `flags` object: Selos vinculados ao produto. - `data` object[]: Lista dos selos vinculados ao produto. - `id` integer: ID do selo. - `name` string: Nome do selo. - `slug` string: Slug do selo. - `text_color` string: Cor do texto do selo, em hexadecimal. - `background_color` string: Cor de fundo do selo, em hexadecimal. - `image_url` string, nullable: URL do ícone do selo, quando configurado. - `variations` object: Variações do produto (ex.: cor, tamanho). - `data` object[]: Lista das variações do produto. - `id` integer: ID da variação. - `name` string: Nome da variação (ex.: Cor). - `values` object: Valores disponíveis para a variação. - `data` object[]: Lista dos valores disponíveis para a variação. - … - `skus` object: SKUs do produto. - `data` object[]: Lista dos SKUs do produto. - `id` integer: ID do SKU. - `product_id` integer: ID do produto ao qual o SKU pertence. - `sku` string: Código do SKU. - `blocked_sale` boolean: Indica se o SKU está bloqueado para novos pedidos. - `title` string: Título de exibição do SKU (ex.: combinação de variações). - `availability` integer: Prazo de disponibilidade do SKU, em dias úteis. - `variations` object[]: Variações que compõem este SKU. - `name` string: Nome da variação (ex.: Cor). - `id` integer: ID da variação. - `value` string: Valor selecionado da variação (ex.: Azul). - `value_id` integer: ID do valor selecionado da variação. - `days_availability_formated` string: Prazo de disponibilidade do SKU formatado para exibição. - `price_sale` number, float: Preço de tabela do SKU, sem descontos aplicados. - `price_discount` number, float: Preço promocional cadastrado no SKU. Quando maior que zero, substitui o preço de tabela. - `combinations` string: Identificador da combinação de variações do SKU, formado pela concatenação dos IDs das opções de variação selecionadas. - `order` integer: Ordem de exibição do SKU entre as variações do produto. - `total_in_stock` integer: Quantidade total em estoque do SKU. - `stock_status` 'in_stock' | 'out_of_stock' | 'backorder': Se 1 unidade do SKU pode ser comprada agora, com a mesma regra do checkout. backorder: vende sem estoque com prazo maior. - `barcode` string, nullable: Código de barras (GTIN/EAN) do SKU. - `allow_sell_without_customization` boolean: Indica se o SKU pode ser vendido sem preencher as customizações, quando o produto tiver customizações cadastradas. - `image_reference_sku_id` integer, nullable: ID do SKU de referência de onde as imagens deste SKU são herdadas, quando configurado. - `purchase_url` string, uri: URL direta de compra do SKU. - `prices` object: Preços e condições de pagamento do SKU. - `data` object: Dados de preços e condições de pagamento do SKU. - … - `images` object: Imagens do SKU. - `data` object[]: Lista das imagens do SKU. - … - `customizations` object: Customizações disponíveis para o SKU. - `data` object[]: Lista das customizações disponíveis para o SKU. - … - `extras` object: Dados complementares do produto. - `data` object: Conteúdo dos dados complementares do produto. - `video` string: URL do vídeo do produto. - `total_in_stock` integer: Quantidade total em estoque do produto. - `for_gift` boolean: Indica se é para presente - `texts` object: Textos descritivos do produto. - `data` object: Conteúdo dos textos descritivos do produto. - `description` string: Descrição completa do produto. - `specifications` string: Especificações técnicas do produto. - `measures` string: Medidas e dimensões do produto. - `seo` object: Dados de SEO da página do produto. - `data` object: Conteúdo dos dados de SEO da página do produto. - `seo_title` string: Título usado para SEO (tag ``) da página do produto. - `seo_description` string: Descrição usada para SEO (meta description) da página do produto. - `seo_keywords` string: Palavras-chave usadas para SEO da página do produto. - `canonical_url` string: URL canônica da página do produto, usada para SEO. - `categories` object: Categorias vinculadas ao produto. - `data` object[]: Lista das categorias vinculadas ao produto. - `id` integer: ID da categoria. - `name` string: Nome da categoria. - `parent_id` integer, nullable: ID da categoria pai, quando a categoria for uma subcategoria. - `slug` string: Slug da categoria, usado na URL. - `url_path` string: Caminho relativo da URL da categoria. - `breadcrumbs` object: Trilha de navegação (breadcrumbs) do produto. - `data` object[]: Lista das categorias que compõem a trilha de navegação do produto. - `id` integer: ID da categoria na trilha de navegação. - `name` string: Nome da categoria na trilha de navegação. - `url_path` string: Caminho relativo da URL da categoria na trilha de navegação. - `banners` BannersPublic[]: Banners exibidos na página da coleção. - `data` object[], required: Lista dos banners retornados. - `id` integer, required: ID do banner. - `product_id` integer, nullable: ID do produto vinculado ao banner, quando o banner apontar para um produto específico. - `type` string, required: Tipo do banner: `image` (banner de imagem) ou `product` (banner vinculado a um produto, exigindo `product_id`). - `active` boolean, required: Indica se o banner está ativo. - `home` boolean, required: Indica se o banner é exibido na página inicial. - `name` string, required: Nome do banner. - `slug` string, required: Slug do banner. - `image_url` string, uri, nullable: URL da imagem do banner para exibição em desktop. - `mobile_image_url` string, uri, nullable: URL da imagem do banner para exibição em dispositivos móveis. - `link` string, uri, nullable: URL de destino ao clicar no banner. - `expired` boolean, required: Indica se o período de exibição do banner já expirou. - `stopwatch` string, nullable: Texto de contagem regressiva exibido no banner, quando configurado. - `stopwatch_expires_in` integer, nullable: Tempo restante, em segundos, para o fim da contagem regressiva do banner. - `start_at` BaseTimestamp, required: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer: Número de representação do timezone. - `timezone` string: Fuso horário associado. - `end_at` BaseTimestamp, required: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer: Número de representação do timezone. - `timezone` string: Fuso horário associado. - `first_banner` object, required: Dados resumidos do primeiro banner ativo do grupo. - `id` integer, required: ID do primeiro banner ativo do grupo. - `link` string, uri, nullable: URL de destino ao clicar no primeiro banner do grupo. - `image` string, uri, nullable: URL da imagem do primeiro banner do grupo para exibição em desktop. - `mobile_image` string, uri, nullable: URL da imagem do primeiro banner do grupo para exibição em dispositivos móveis. - `stopwatch` string, nullable: Texto de contagem regressiva exibido no primeiro banner do grupo, quando configurado. - `dimensions` object, required: Dimensões recomendadas para as imagens do banner. - `desktop` object, required: Dimensões recomendadas para a imagem exibida em desktop. - `width` string, required: Largura recomendada para a imagem do banner em desktop. - `height` string, required: Altura recomendada para a imagem do banner em desktop. - `mobile` object, required: Dimensões recomendadas para a imagem exibida em dispositivos móveis. - `width` string, required: Largura recomendada para a imagem do banner em mobile. - `height` string, required: Altura recomendada para a imagem do banner em mobile. - `product` object, required: Produtos vinculados ao banner. - `data` ProductBannerPublic[], required: Lista dos produtos vinculados ao banner. - `data` object: Dados do produto vinculado ao banner. - `id` integer: ID do produto. - `name` string: Nome do produto. - `slug` string: Slug do produto, usado na URL da página do produto. - `blocked_sale` boolean: Indica se o produto está bloqueado para novos pedidos. - `rating` string: Nota média de avaliação do produto, formatada para exibição. - `url` string, uri: URL completa da página do produto na loja. - `url_path` string: Caminho relativo da URL da página do produto. - `brand` object: Marca do produto. - … - `images` object: Imagens do produto. - … - `prices` object: Preços e condições de pagamento do produto. - … ## Other responses - `404`: Coleção não encontrada ## Changes - **2026-11-03** `bbafb577e11c`: 1 info - endpoint added [Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/public/catalog/collections:id[]}/get.md) --- [API](https://skmtc.dev/yampi/apis/yampi-api.md) - [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yampi/apis/yampi-api/revisions/74739ec8876f?raw)